Feat: Support Recipe Parameters in Goose desktop app by AaronGoldsmith · Pull Request #3155 · block/goose

AaronGoldsmith · 2025-06-29T22:39:01Z

This pull request introduces enhancements to support recipe parameters in the desktop UI, including parameter substitution, validation, and serialization. The changes span multiple files, adding functionality for parameter handling in recipes, improving user interaction, and enabling serialization of parameters to YAML format.

✨ What's New

Recipe Parameters - Transform your recipes into flexible, reusable templates with dynamic parameter substitution! 🎯

This PR introduces a powerful new parameter system that allows recipes to accept user input at runtime, making them adaptable to different projects, environments, and use cases.

🚀 Key Features

🔧 Parameter Definition

Flexible Parameter Types - Support for both required and optional parameters
Rich Metadata - Each parameter includes name, description, and requirement status
Template Syntax - Use {{parameter_name}} placeholders in instructions and prompts
Type Safety - Full TypeScript interface support for parameter definitions

🎨 Interactive Parameter Collection

Smart Modal Interface - Beautiful parameter input modal with validation
Real-time Validation - Visual feedback for required fields with error states
User-friendly UX - Clear labels, descriptions, and intuitive form design
Flexible Cancel Flow - Options to return to form or start fresh chat

⚡ Dynamic Substitution

Runtime Replacement - Parameters are substituted when recipe is executed
Robust Parsing - Enhanced regex-based substitution with special character support
Debug Support - Console logging for troubleshooting parameter substitution

🎁 User Experience Enhancements

Dynamic, parameterized recipes
Reusable templates across projects
Interactive setup with guided parameter collection
Smart validation and error handling

🔧 Technical Implementation

Core Components

Parameter Interface - Type-safe parameter definitions
ParameterInputModal - React component for parameter collection
substituteParameters - Enhanced substitution engine with debugging
Recipe Integration - Seamless parameter flow from editor to execution

Parameter Flow

Recipe Definition - Author defines parameters in recipe metadata
Parameter Collection - Modal prompts user for required/optional values
Template Substitution - Parameters replaced in instructions and prompts
Chat Execution - Recipe runs with personalized content

🎨 UI/UX Features

Validation States - Red borders and error messages for invalid inputs
Smart Buttons - "Start Recipe" CTA with proper validation
Cancel Options - Flexible cancel flow with clear choices
Rounded Design - Consistent button styling with theme support
Backdrop Effects - Subtle blur overlay for modal focus

🔧 Development Notes

Force Push Required: Local git hooks were automatically running linting and including formatting changes in merge commits. A force push was necessary to maintain clean commit history and separate linting changes from feature implementation.

✅ Testing

✅ TypeScript compilation passes
✅ ESLint checks pass (0 warnings)
✅ Parameter substitution verified with test recipes
✅ Modal validation tested for required/optional parameters
✅ Cancel flow tested for all scenarios
✅ Template syntax parsing verified with special characters

📁 Files Changed

ui/desktop/src/types/recipe/index.ts - Parameter interface definitions
ui/desktop/src/components/ParameterInputModal.tsx - Parameter collection UI
ui/desktop/src/components/RecipeEditor.tsx - Recipe parameter integration
ui/desktop/src/main.ts - Parameter substitution and chat window creation
ui/desktop/src/utils/parameterSubstitution.ts - Template processing engine

Result: Recipes are now powerful, reusable templates that adapt to any context. Users can create once and reuse everywhere with personalized parameter values! 🎉

…ents

AaronGoldsmith · 2025-06-30T00:23:25Z

ui/desktop/src/components/ChatView.tsx

+    // Escape special characters in the key (parameter) and match optional whitespace
+    const regex = new RegExp(`{{\\s*${key.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')}\\s*}}`, 'g');
+    const beforeSubstitution = substitutedPrompt;
+    substitutedPrompt = substitutedPrompt.replace(regex, params[key]);


Treat the parameter as literal text, to avoid regex injection and unintended matching.

For example, without santization

// matches {{user_name}}, {{user-name}}, etc substitutedPrompt.replace(new RegExp('{{user.name}}'), value)

with sanitization

// matches exactly {{user.name}} substitutedPrompt.replace(new RegExp('{{user\.name}}'), value)

…rompt' and remove unused options in ParameterInput refactor: simplify onClose handler in ParameterInputModal and clean up styling comments

…ges and avoid duplicates

* main: return missign npx/uvx (block#3148) docs: add more instructions about resuming a session for cli users (block#3146)

katzdave · 2025-06-30T19:32:49Z

ui/desktop/src/components/ChatView.tsx

+
+    // Log each substitution for debugging
+    if (beforeSubstitution !== substitutedPrompt) {
+      console.log(`Replaced {{${key}}} with "${params[key]}"`);


rm logging.

katzdave · 2025-06-30T19:32:54Z

ui/desktop/src/components/ChatView.tsx

+    }
+  }
+
+  console.log('Final substituted prompt:', substitutedPrompt);


katzdave · 2025-06-30T19:44:56Z

ui/desktop/src/utils/providerUtils.ts

+
+    // Log each substitution for debugging
+    if (beforeSubstitution !== substitutedText) {
+      console.log(`Replaced {{${key}}} with "${params[key]}" in instructions`);


more logging.

katzdave

Took another look + tested some more with recipes with various types of params. I think looks good.

angiejones · 2025-07-02T14:57:52Z

ui/desktop/src/components/ChatView.tsx


-      // Create and send the user message
-      const userMessage = createUserMessage(recipeConfig.prompt);
+      console.log('Auto-sending substituted prompt for scheduled execution:', finalPrompt);


can remove?

angiejones · 2025-07-02T15:38:04Z

ui/desktop/src/components/RecipeEditor.tsx

    console.log('Final config extensions:', config.extensions);
+
+    const yamlString = serializeParametersToYAML(parameters);
+    console.log('Serialized Parameters to YAML:', yamlString);


can remove?

angiejones · 2025-07-02T15:38:53Z

ui/desktop/src/utils/providerUtils.ts

+    const originalInstructions = (recipeConfig as { instructions?: string })?.instructions;
+
+    if (!originalInstructions) {
+      console.log('No instructions to substitute parameters in');


can remove?

angiejones · 2025-07-02T15:39:27Z

ui/desktop/src/utils/providerUtils.ts

+
+    if (!response.ok) {
+      console.warn(`Failed to update system prompt with parameters: ${response.statusText}`);
+    } else {


can remove the else clause?

AaronGoldsmith · 2025-07-02T16:44:22Z

.github/workflows/build-cli.yml

+
              # Move the built binary to the expected location (inside container)
              mkdir -p ../target/x86_64-pc-windows-gnu/release
              mv temporal-service.exe ../target/x86_64-pc-windows-gnu/release/temporal-service.exe
-              
+


Gah, sorry – I have automatic linting on, and it linted all the changed files from the merge. Let me know if I should revert the whitespace issues.

* main: (37 commits) fix: fix desktop recipe url generation (block#3209) feat: improve UX for saving recipes (block#3214) fix: Pass Google AI API key in HTTP header, not query param (block#3192) docs: add linter to CONTRIBUTING.md (block#3168) feat: Structured output for recipes (block#3188) Fix cost tracking accuracy and OpenRouter model pricing (block#3189) docs: update cli install instructions for windows (block#3205) Docs: Cost tracking on the desktop app (block#3204) feat: Adding streamable-http transport support for backend, desktop and cli (block#2942) fix: use the correct `contains` syntax on create-recipe-pr.yml (block#3193) Temporarily Remove GH Copilot Provider (block#3199) docs: fix tab navigation (block#3201) feat: use tiktoken-rs instead of tokenizers, single global tokenizer (block#3115) add playwright-mcp server to extensions list (block#3010) Add `/extension` path for extension installation (block#3011) feat(desktop): Prioritize suffix when truncating path in header (block#3110) chore(release): release version 1.0.31 (block#3185) feat: additional sub recipes via command line (block#3163) Add Internal Recipes To Recipes Cookbook (block#3179) pipe the argument to storage (block#3184) ...

AaronGoldsmith · 2025-07-02T17:17:52Z

I'm going to need to force push to reset the branch back to a healthy state. I'll re-request reviews

* main: Defend against invalid sessions (block#3229) Clean up session file optionality for --no-session (block#3230) Feat: Support Recipe Parameters in Goose desktop app (block#3155) docs: update recipe example (block#3222) Add native OAuth 2.0 authentication support to MCP client (block#3213) build: Check in Cargo.lock changes (block#3220) fix: fix desktop recipe url generation (block#3209) feat: improve UX for saving recipes (block#3214)

* main: (150 commits) Defend against invalid sessions (block#3229) Clean up session file optionality for --no-session (block#3230) Feat: Support Recipe Parameters in Goose desktop app (block#3155) docs: update recipe example (block#3222) Add native OAuth 2.0 authentication support to MCP client (block#3213) build: Check in Cargo.lock changes (block#3220) fix: fix desktop recipe url generation (block#3209) feat: improve UX for saving recipes (block#3214) fix: Pass Google AI API key in HTTP header, not query param (block#3192) docs: add linter to CONTRIBUTING.md (block#3168) feat: Structured output for recipes (block#3188) Fix cost tracking accuracy and OpenRouter model pricing (block#3189) docs: update cli install instructions for windows (block#3205) Docs: Cost tracking on the desktop app (block#3204) feat: Adding streamable-http transport support for backend, desktop and cli (block#2942) fix: use the correct `contains` syntax on create-recipe-pr.yml (block#3193) Temporarily Remove GH Copilot Provider (block#3199) docs: fix tab navigation (block#3201) feat: use tiktoken-rs instead of tokenizers, single global tokenizer (block#3115) add playwright-mcp server to extensions list (block#3010) ...

…x-turns * origin/main: Defend against invalid sessions (#3229) Clean up session file optionality for --no-session (#3230) Feat: Support Recipe Parameters in Goose desktop app (#3155) docs: update recipe example (#3222) Add native OAuth 2.0 authentication support to MCP client (#3213) build: Check in Cargo.lock changes (#3220) fix: fix desktop recipe url generation (#3209) feat: improve UX for saving recipes (#3214) fix: Pass Google AI API key in HTTP header, not query param (#3192) docs: add linter to CONTRIBUTING.md (#3168)

Signed-off-by: Adam Tarantino <tarantino.adam@gmail.com>

Signed-off-by: Soroosh <soroosh.sarabadani@gmail.com>

Signed-off-by: Kyle Santiago <kyle@privkey.io>

AaronGoldsmith and others added 8 commits June 28, 2025 20:26

feat: add parameter handling in recipe and chat components

34ae360

wip: add parameter interface

ffedce4

remove unused imports and fix eslint issues

370cbfd

update todo

400850c

feat: enhance parameter handling with logging and validation improvem…

3ffb6e1

…ents

feat: implement parameter substitution in system prompt update

8e89bf4

feat: enhance ParameterInputModal with validation and cancel options

a585e97

remove todos

6f0c02c

AaronGoldsmith commented Jun 30, 2025

View reviewed changes

feat: update parameter requirement type from 'interactive' to 'user_p…

6f08a03

…rompt' and remove unused options in ParameterInput refactor: simplify onClose handler in ParameterInputModal and clean up styling comments

AaronGoldsmith marked this pull request as ready for review June 30, 2025 01:06

AaronGoldsmith added 2 commits June 30, 2025 08:39

fix: update parameter handling in RecipeEditor to include prompt chan…

9e4bd22

…ges and avoid duplicates

Merge branch 'main' into ag/feat-desktop-recipe-params

2d41dd8

* main: return missign npx/uvx (block#3148) docs: add more instructions about resuming a session for cli users (block#3146)

katzdave reviewed Jun 30, 2025

View reviewed changes

refactor: remove console logging from parameter substitution functions

4ad4ea9

katzdave approved these changes Jul 1, 2025

View reviewed changes

angiejones reviewed Jul 2, 2025

View reviewed changes

AaronGoldsmith added 2 commits July 2, 2025 09:28

address feedback

8e8b042

Removed unused js-yaml

2f29d52

AaronGoldsmith commented Jul 2, 2025

View reviewed changes

refactor: remove success log from updateSystemPromptWithParameters

e314a58

AaronGoldsmith force-pushed the ag/feat-desktop-recipe-params branch from 6ad0a3a to e314a58 Compare July 2, 2025 17:19

AaronGoldsmith requested a review from angiejones July 2, 2025 17:19

angiejones merged commit 2e97621 into block:main Jul 2, 2025
9 of 10 checks passed

chaitanyarahalkar mentioned this pull request Jul 5, 2025

Macos-only Sandboxing chaitanyarahalkar/goose#9

Open

atarantino pushed a commit to atarantino/goose that referenced this pull request Jul 14, 2025

Feat: Support Recipe Parameters in Goose desktop app (block#3155)

14e6240

Signed-off-by: Adam Tarantino <tarantino.adam@gmail.com>

s-soroosh pushed a commit to s-soroosh/goose that referenced this pull request Jul 18, 2025

Feat: Support Recipe Parameters in Goose desktop app (block#3155)

ed1ae33

Signed-off-by: Soroosh <soroosh.sarabadani@gmail.com>

kwsantiago pushed a commit to kwsantiago/goose that referenced this pull request Jul 19, 2025

Feat: Support Recipe Parameters in Goose desktop app (block#3155)

ae8417a

Signed-off-by: Kyle Santiago <kyle@privkey.io>

cbruyndoncx pushed a commit to cbruyndoncx/goose that referenced this pull request Jul 20, 2025

Feat: Support Recipe Parameters in Goose desktop app (block#3155)

5db1cee

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: Support Recipe Parameters in Goose desktop app#3155

Feat: Support Recipe Parameters in Goose desktop app#3155
angiejones merged 16 commits intoblock:mainfrom
AaronGoldsmith:ag/feat-desktop-recipe-params

AaronGoldsmith commented Jun 29, 2025 •

edited

Loading

Uh oh!

AaronGoldsmith Jun 30, 2025

Uh oh!

katzdave Jun 30, 2025

Uh oh!

katzdave Jun 30, 2025

Uh oh!

katzdave Jun 30, 2025

Uh oh!

katzdave left a comment

Uh oh!

angiejones Jul 2, 2025

Uh oh!

angiejones Jul 2, 2025

Uh oh!

angiejones Jul 2, 2025

Uh oh!

angiejones Jul 2, 2025

Uh oh!

AaronGoldsmith Jul 2, 2025

Uh oh!

AaronGoldsmith commented Jul 2, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

AaronGoldsmith commented Jun 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✨ What's New

🚀 Key Features

🔧 Parameter Definition

🎨 Interactive Parameter Collection

⚡ Dynamic Substitution

🎁 User Experience Enhancements

🔧 Technical Implementation

Core Components

Parameter Flow

🎨 UI/UX Features

🔧 Development Notes

✅ Testing

📁 Files Changed

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

katzdave left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AaronGoldsmith commented Jul 2, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

AaronGoldsmith commented Jun 29, 2025 •

edited

Loading